home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / windows / filemate.zip / README.TXT < prev    next >
Text File  |  1996-08-07  |  11KB  |  251 lines
  1. README.TXT
  2. Chess FileMate for Windows, 4.0
  3. Copyright (c) 1994-1996 William H. Dyche
  4. 74401.3055@compuserve.com
  5.  
  6.  
  7. All documentation for FileMate is contained in the following files...
  8.  
  9.  - README.TXT  -  program overview, getting-started instructions
  10.  
  11.       1: Purpose and Capabilities
  12.       1.1: FileMate 4.0 features.
  13.  
  14.       2: System Requirements
  15.  
  16.       3: Installation from diskette
  17.  
  18.       4: Getting Started
  19.       4.1: Scenario 1:  Open a file and view a game.
  20.       4.2: Scenario 2:  Create a game
  21.       4.3: Scenario 3:  Update a game-in-progress
  22.  
  23.       5: Program Capacity and Performance.
  24.  
  25.       6: Miscellaneous
  26.       6.1: filemate.ini
  27.       6.2  Contacting the author
  28.  
  29.  
  30.  - FMNEW.TXT   -  history of changes
  31.  
  32.  - FMGUIDE.TXT -  detailed description of the program and how to use it
  33.  
  34.  - FMDATA.TXT  -  data requirements, PGN and FEN
  35.  
  36.  - DEMO1.TXT, DEMO2.CBI, DEMO2.CBF  -  data files for demonstration
  37.  
  38.  
  39. 1: Purpose and Capabilities
  40.       
  41. FileMate is a games-file viewer and recorder.  It facilitates the viewing,
  42. creation, and maintenance of ASCII text files containing recorded chess games.
  43. Such files can be found in the libraries of the CompuServe Chess Forum, and at
  44. many chess-related computer network sites. 
  45.  
  46. FileMate is an entry-level study-aid program for chess players. Much effort has
  47. gone into making the program easy to use. It is designed to be usable with little
  48. or no technical knowledge. And it is low cost for those who want to try out chess
  49. software before committing to a complicated and expensive chess database system.
  50.  
  51. The Shareware Version of this product is intended for demonstration and evaluation
  52. purposes.  It is constrained to read no more than the first 200 games of a file.
  53. Otherwise, it is fully functional.  The constraint can be removed by entering a
  54. valid combination of a name and registration code.  See the program's AboutBox for
  55. registration instructions.
  56.  
  57.  
  58. 1.1: In brief, FileMate 4.0 has these features.
  59.  
  60.  -  MDI interface    Child windows can be created, moved, and resized.  Window
  61.                      sizes and locations are remembered.
  62.               
  63.  -  File support     The File window lists games in a file and enables you to
  64.              select games for viewing and/or editing.  Games can be
  65.              added, edited, and deleted, and moved around within a file.
  66.              File backups are created during file saves.
  67.  
  68.  -  Boards           Three sizes, and various styles.  Two piece sets.  Autoplay
  69.              and speed controls.  Pieces can be moved using mouse drag-
  70.              and-drop.  Piece movement is clarified when playing forward
  71.              by floating the piece to its destination.
  72.                                 
  73.  -  Data editing     Edit game data by double-clicking text displayed in the
  74.                      Board Data window to invoke an edit dialog. 
  75.  
  76.  -  Formats:         The program reads games in formats PGN, NTR, and NIC. Games
  77.                      are displayed and saved in standard PGN format.
  78.  
  79.  -  Notation:        Algebraic, Descriptive, and coordinate move notations are
  80.              supported. Language translation is supported for displayed
  81.              output.
  82.  
  83.  -  Keyboard:        Most functions can be accessed from the keyboard.
  84.  
  85.  -  Clipboard:       Games can be imported from, or exported to, the Clipboard.
  86.              Selected data, such as the last n moves, can be copied with
  87.              the Post function.  A bitmap picture of the board can be
  88.              copied to the Clipboard.  
  89.  
  90.  -  .INI File:       Your preferred option settings are retained from one run to
  91.                      the next. The sizes and positions of windows are remembered.  
  92.  
  93.  -  Error handling   Advanced error handling techniques enable the program to
  94.              detect, report, and recover from, a large number of data
  95.              error conditions.
  96.  
  97.  
  98. 2: System Requirements
  99.     
  100.  -  Windows 3.1 or higher. 
  101.  -  color VGA.  The program is specifically designed to work in regular
  102.     and super VGA.  If you are using regular VGA (640x480x16) resolution,
  103.     be aware that the program looks better and displays more data in the
  104.     SVGA (800x600x16) resolution.  The largest board size is a little to
  105.     big for regular VGA.
  106.  
  107.  -  720K of disk space is required for version 4.0.
  108.  
  109. A basic working knowledge of standard Windows controls is assumed.
  110. Knowledge of how to play chess is assumed.
  111.  
  112.  
  113. 3: Installation from diskette
  114.  
  115. Use the install program.  It will let you choose a directory for the files.
  116.  
  117. Tell the Program Manager to run program INSTALL on the diskette.
  118.    ( In the Program Manager window, select menu item "File / Run".  Then 
  119.    enter the drive letter, colon, and program name (e.g.  B:INSTALL). )
  120.  
  121. Start the program by double-clicking the FileMate icon,
  122. or run C:\FILEMT\FILEMATE.EXE
  123.  
  124.  Contents of the diskette:
  125.     install.exe,  install.ini,  filemate.exe,  fm40d1.dll,  filemate.ini
  126.     sqv5.dll
  127.     readme.txt,  fmnew.txt, guide.txt,  demo1.txt,  demo2.cbi, demo2.cbf
  128.  
  129. Un-installing the product:    
  130. All Chess FileMate files are located in C:FILEMT and its subdirectories, if any.  
  131. Aside from the group definition, no files outside of C:FILEMT are modified.
  132. 1.  Delete directory C:FILEMT  (or wherever you put it)
  133. 2.  Delete group FileMate  (or delete the FileMate icon)
  134.  
  135.  
  136. 4: Getting Started   
  137.  
  138. Clicking down on buttons and menu items will display a brief explanation in
  139. the main window's status area.  For detailed how-to information, please refer
  140. to fmguide.txt.
  141.  
  142. Demonstration data files will appear in the MRU file list - click the MRU 
  143. button in the File window, then doubleclick one of the files listed.
  144.  
  145. Creating variations and comments is extremely easy, but it may not be
  146. obvious how to do it since no buttons or menu items are involved.
  147.  
  148.  - Create a variation:  Go to the desired play/position and start entering
  149.    moves on the board. 
  150.  - Add or change comments:  Double-click a play in the text display.  A
  151.    specialized edit dialog will pop-up.
  152.  
  153. 4.1: Scenario 1:  Open a file and view a game.
  154.  
  155.  -  Click the Open button in the File window, and open a chess data file.  As
  156.     the file is read, games are listed in File window in the order they are
  157.     found.  You can begin viewing games as soon as they show up in the list,
  158.     even while the file is still being read.
  159.  
  160.  -  Double-click any game in the list.  The game's data will be sent to the
  161.     Board (and to a Text Editor window if one exists).  The program will then
  162.     extract information from the text and check for errors.  If any errors
  163.     are found, the error reporter dialog will be displayed.  In many cases, an
  164.     error will result only in a warning or the non-extraction of some
  165.     information from the data.  Errors, especially in the game's moves, should
  166.     be fixed before copying the game (Save) back to the file to prevent loss
  167.     of data.
  168.  
  169.  -  Review the game using the navigation controls to quickly go to the
  170.     beginning << or end >> of the game, and to step forward > and backward <
  171.     through the game.  The horizontal scroll bar can be used for quick
  172.     browsing.  Use the auto-play button  >o  to start and stop automatic play
  173.     of the game.  You can also go directly to any position by selecting a play
  174.     in the Board Data window.  To quickly review a game, use the left and
  175.     right arrow cursor control keys. 
  176.  
  177.  
  178. 4.2: Scenario 2:  Create a game
  179.  
  180.  -  Click the New button on the Board Data window.
  181.  
  182.  -  Double-click any header field to change its value. You don't actually have
  183.     to enter any header information (but you should at least enter the player
  184.     names).  Missing information in the header will be indicated with question
  185.     marks and byphens.  Header information can be changed at any time.
  186.  
  187.  -  Enter moves on the board by using the mouse to drag-and-drop pieces. If you
  188.     wish, you can use the controls to go to any point in the game, and add or
  189.     delete moves, and to add variations.
  190.  
  191.     ( Saving Changes:  It may not be immediately apparent how to save changes
  192.     because there are two Save buttons.  Just follow the next step, and review
  193.     FMGUIDE.TXT for details about this design. )
  194.  
  195.  -  To save data you've entered or changed, click the Add or Save button on the
  196.     Board Data window.  Later, you will also need to save changes to disk
  197.     ("Save" in the File window).  If you don't tell the program to save
  198.     changes, it will prompt you to do so before overwriting the data or exiting
  199.     the program.
  200.  
  201.  -  Double-click any play or comment to edit suffix-annotations and comments.
  202.     Any play can have a comment and/or an annotation symbol.
  203.  
  204. It is also possible to edit a game in a text editor as follows.  Create a
  205. Text Editor window if one doesn't already exist.  Click the editor's Get
  206. button (to get data from the board).  Make changes, and then click the Send
  207. button (send data to the board).  From there, the game data can be saved to a
  208. file as in the previous step.
  209.  
  210.  
  211. 4.3: Scenario 3:  Update a game-in-progress
  212.  
  213.  -  Open a file.
  214.  -  Double-click a game to put it on the board.
  215.  -  Enter moves on the board
  216.  -  Click Save (to file) on the Board Data window.
  217.  -  Click Save (to disk) on the File window.
  218.     While the game is on the board, you can create a correspondance reply by
  219.     using the "Post selected data..." dialog.
  220.  
  221.  
  222. 5: Program Capacity and Performance.
  223.  
  224. This information is specific to release 4.0 of FileMate and could change in
  225. future releases.  These are some of the program's design limitations...
  226.  
  227.  -  MAXGAMESIZE = 24,000.  Individual games are limited to 24000 characters.
  228.  
  229.  -  MAXPNODES = 800.  This is the limit on the number of plays (i.e. halfmoves)
  230.                       that a single game can have (main line plus variations).
  231.  
  232.  -  MAXGAMES  = 14,000.   This is the maximum number of games that can be read
  233.               from a text file.  This value cannot be exceeded by file
  234.               appends.
  235.               = 200   in the shareware version
  236.  
  237. Functional limitations:  
  238.  -  The program has no information search capability.  This would be more
  239.     appropriate for a database system.
  240.  
  241.  -  This program is designed as an interactive study-aid, not as a conversion
  242.     utility.  It can read and display various formats and notations.  But the
  243.     current design only exports/saves games in standard PGN format.
  244.  
  245. 6: Miscellaneous 
  246.  
  247. 6.1:  FILEMATE.INI is not documented.  It is maintained by the program and
  248. need not be edited by the user. 
  249.  
  250. 6.2:  Please refer to Help/About on how to contact the author of FileMate.
  251. Questions, suggestions, and problem reports are always welcome.